

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>The pyamp module &mdash; pyamp v1.2 documentation</title>
    <link rel="stylesheet" href="../_static/default.css" type="text/css" />
    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '../',
        VERSION:     '1.2',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="../_static/jquery.js"></script>
    <script type="text/javascript" src="../_static/underscore.js"></script>
    <script type="text/javascript" src="../_static/doctools.js"></script>
    <link rel="top" title="pyamp v1.2 documentation" href="../index.html" />
    <link rel="next" title="The documentation module" href="mod_pyamp_documentation.html" />
    <link rel="prev" title="Installing pyamp" href="../installation.html" /> 
  </head>
  <body>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="mod_pyamp_documentation.html" title="The documentation module"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="../installation.html" title="Installing pyamp"
             accesskey="P">previous</a> |</li>
        <li><a href="../index.html">pyamp v1.2 documentation</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="the-pyamp-module">
<h1>The pyamp module<a class="headerlink" href="#the-pyamp-module" title="Permalink to this headline">¶</a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="mod_pyamp_documentation.html">The documentation module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="pyamp_documentation_rstGeneration.html">The rstGeneration module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="pyamp_documentation_rstGeneration.html#the-rstoptions-class">The RstOptions class</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyamp_documentation_rstGeneration.html#the-rstmoduledirectory-class">The RstModuleDirectory class</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyamp_documentation_rstGeneration.html#the-rstbase-class">The RstBase class</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyamp_documentation_rstGeneration.html#the-rstmodule-class">The RstModule class</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="mod_pyamp_logging.html">The logging module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="pyamp_logging_colors.html">The colors module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="pyamp_logging_colors.html#the-colors-class">The Colors class</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="pyamp_logging_logger.html">The logger module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="pyamp_logging_logger.html#the-singlelogger-class">The SingleLogger class</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyamp_logging_logger.html#the-loglevel-class">The LogLevel class</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyamp_logging_logger.html#the-prefix-class">The Prefix class</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyamp_logging_logger.html#the-logdata-class">The LogData class</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyamp_logging_logger.html#the-colors-class">The Colors class</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyamp_logging_logger.html#the-filelogger-class">The FileLogger class</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyamp_logging_logger.html#the-logger-class">The Logger class</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="pyamp_logging_prefix.html">The prefix module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="pyamp_logging_prefix.html#the-fnprefix-class">The FnPrefix class</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyamp_logging_prefix.html#the-colors-class">The Colors class</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyamp_logging_prefix.html#the-prefix-class">The Prefix class</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyamp_logging_prefix.html#the-timeprefix-class">The TimePrefix class</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="pyamp_logging_loggable.html">The loggable module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="pyamp_logging_loggable.html#the-logdata-class">The LogData class</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyamp_logging_loggable.html#the-colors-class">The Colors class</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyamp_logging_loggable.html#the-logger-class">The Logger class</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyamp_logging_loggable.html#the-loggable-class">The Loggable class</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="pyamp_logging_meta.html">The meta module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="pyamp_logging_meta.html#the-loglevel-class">The LogLevel class</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyamp_logging_meta.html#the-functionloggermeta-class">The FunctionLoggerMeta class</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyamp_logging_meta.html#the-logger-class">The Logger class</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyamp_logging_meta.html#the-prefix-class">The Prefix class</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyamp_logging_meta.html#the-loggermeta-class">The LoggerMeta class</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="mod_pyamp_patterns.html">The patterns module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="mod_pyamp_patterns_interfaces.html">The interfaces module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="pyamp_patterns_interfaces_finalFunctionsMeta.html">The finalFunctionsMeta module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyamp_patterns_interfaces_requiredProperties.html">The requiredProperties module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyamp_patterns_interfaces_interface.html">The interface module</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="pyamp_patterns_borg.html">The borg module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="pyamp_patterns_borg.html#the-borg-class">The Borg class</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="pyamp_patterns_decorators.html">The decorators module</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyamp_patterns_enum.html">The enum module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="pyamp_patterns_enum.html#the-enum-class">The Enum class</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="mod_pyamp_ui.html">The ui module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="mod_pyamp_ui_qt.html">The qt module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="pyamp_ui_qt_widgetList.html">The widgetList module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyamp_ui_qt_baseWidget.html">The baseWidget module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyamp_ui_qt_interrupt.html">The interrupt module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyamp_ui_qt_keyEvents.html">The keyEvents module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyamp_ui_qt_resizePolicy.html">The resizePolicy module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyamp_ui_qt_spacers.html">The spacers module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyamp_ui_qt_styleSheet.html">The styleSheet module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyamp_ui_qt_scrollableList.html">The scrollableList module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyamp_ui_qt_baseView.html">The baseView module</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="mod_pyamp_ui_input.html">The input module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="pyamp_ui_input_keys.html">The keys module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyamp_ui_input_console.html">The console module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyamp_ui_input_evdev.html">The evdev module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyamp_ui_input_userInput.html">The userInput module</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="mod_pyamp_web.html">The web module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="mod_pyamp_web_html.html">The html module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="pyamp_web_html_baseElement.html">The baseElement module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyamp_web_html_htmlPage.html">The htmlPage module</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="mod_pyamp_web_http.html">The http module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="pyamp_web_http_errorPages.html">The errorPages module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyamp_web_http_server.html">The server module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyamp_web_http_requests.html">The requests module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyamp_web_http_headers.html">The headers module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyamp_web_http_page.html">The page module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyamp_web_http_constants.html">The constants module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyamp_web_http_argument.html">The argument module</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="pyamp_web_hacking.html">The hacking module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="pyamp_web_hacking.html#the-urlrequest-class">The UrlRequest class</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyamp_web_hacking.html#the-hacking-class">The Hacking class</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="pyamp_web_web.html">The web module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="pyamp_web_web.html#the-urlrequest-class">The UrlRequest class</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="mod_pyamp_networking.html">The networking module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="mod_pyamp_networking_sockets.html">The sockets module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="pyamp_networking_sockets_connection.html">The connection module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyamp_networking_sockets_server.html">The server module</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="mod_pyamp_config.html">The config module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="pyamp_config_configFile.html">The configFile module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="pyamp_config_configFile.html#the-configfile-class">The ConfigFile class</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="pyamp_config_option.html">The option module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="pyamp_config_option.html#the-cloption-class">The ClOption class</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyamp_config_option.html#the-clbooloption-class">The ClBoolOption class</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyamp_config_option.html#the-option-class">The Option class</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="pyamp_config_parser.html">The parser module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="pyamp_config_parser.html#the-configfile-class">The ConfigFile class</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyamp_config_parser.html#the-optionsparser-class">The OptionsParser class</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="pyamp_config_conversions.html">The conversions module</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="mod_pyamp_system.html">The system module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="mod_pyamp_system_ubuntu.html">The ubuntu module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="pyamp_system_ubuntu_packages.html">The packages module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyamp_system_ubuntu_menu.html">The menu module</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="mod_pyamp_util.html">The util module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="pyamp_util_inspection.html">The inspection module</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyamp_util_lists.html">The lists module</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyamp_util_functions.html">The functions module</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyamp_util_html.html">The html module</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyamp_util_debugging.html">The debugging module</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyamp_util_setup.html">The setup module</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyamp_util_objects.html">The objects module</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyamp_util_dictionary.html">The dictionary module</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyamp_util_directories.html">The directories module</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyamp_util_sockets.html">The sockets module</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyamp_util_strings.html">The strings module</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="mod_pyamp_processes.html">The processes module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="mod_pyamp_processes_threading.html">The threading module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="pyamp_processes_threading_thread.html">The thread module</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="pyamp_processes_coroutine.html">The coroutine module</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="pyamp_exceptions.html">The exceptions module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="pyamp_exceptions.html#the-finalfunctionerror-class">The FinalFunctionError class</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyamp_exceptions.html#the-invalidpropertyvalueerror-class">The InvalidPropertyValueError class</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyamp_exceptions.html#the-undefinedfunctionerror-class">The UndefinedFunctionError class</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyamp_exceptions.html#the-undefinedpropertyerror-class">The UndefinedPropertyError class</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyamp_exceptions.html#the-invalidconfigurationpropertyvalueerror-class">The InvalidConfigurationPropertyValueError class</a></li>
</ul>
</li>
</ul>
</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
  <h4>Previous topic</h4>
  <p class="topless"><a href="../installation.html"
                        title="previous chapter">Installing pyamp</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="mod_pyamp_documentation.html"
                        title="next chapter">The documentation module</a></p>
  <h3>This Page</h3>
  <ul class="this-page-menu">
    <li><a href="../_sources/_generated/mod_pyamp.txt"
           rel="nofollow">Show Source</a></li>
  </ul>
<div id="searchbox" style="display: none">
  <h3>Quick search</h3>
    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" size="18" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    <p class="searchtip" style="font-size: 90%">
    Enter search terms or a module, class or function name.
    </p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="mod_pyamp_documentation.html" title="The documentation module"
             >next</a> |</li>
        <li class="right" >
          <a href="../installation.html" title="Installing pyamp"
             >previous</a> |</li>
        <li><a href="../index.html">pyamp v1.2 documentation</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2012, Brett Ponsler.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.1.
    </div>
  </body>
</html>